RtkCloseHandle

RtkCloseHandle closes an open object handle.

Syntax

BOOL RtkCloseHandle(
    RTSSINST RtssInst
    PULONG pErrorCode
    HANDLE hObject
);

Parameters

RtssInst

An RTSSINST type returned from call to RtkRtssAttach.

pErrorCode

A pointer to Ulong for error returned code.

hObject

An open object handle.

Return Values

TRUE if the function succeeds. ErrorCode (if defined) is set to NULL, FALSE if the function fails

To get any extended error information, check the ErrorCode value. pErrorCode may be set to NULL on entry and ignored.

Remarks

RtkCloseHandle closes handles to the following RTSS objects:

Mutex
Semaphore
Shared memory
Event

RtkCloseHandle invalidates the specified object handle, decrements the object's handle count, and performs object retention checks. Once the last handle to an object is closed, the object is removed from the operating system.

Requirements

Header	Rtkapi.h
Library	rtx_rtk.lib

| |